<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>SLS_PHP_SDK » \Aliyun_Log_Client</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">SLS_PHP_SDK</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/SLS_PHP_SDK.html"><i class="icon-folder-open"></i> SLS_PHP_SDK</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">290</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<div xmlns:php="http://php.net/xsl" class="btn-toolbar">
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
</div>
<ul xmlns:php="http://php.net/xsl" class="side-nav nav nav-list">
<li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Aliyun_Log_Client constructor"><span class="description">Aliyun_Log_Client constructor</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_getHistograms" title="getHistograms() :: Get histograms of requested query from SLS."><span class="description">Get histograms of requested query from SLS.</span><pre>getHistograms()</pre></a></li>
<li class="method public "><a href="#method_getLogs" title="getLogs() :: Get logs from SLS."><span class="description">Get logs from SLS.</span><pre>getLogs()</pre></a></li>
<li class="method public "><a href="#method_listLogstores" title="listLogstores() :: List all logstores of requested project."><span class="description">List all logstores of requested project.</span><pre>listLogstores()</pre></a></li>
<li class="method public "><a href="#method_listTopics" title="listTopics() :: List all topics in a logstore."><span class="description">List all topics in a logstore.</span><pre>listTopics()</pre></a></li>
<li class="method public "><a href="#method_putLogs" title="putLogs() :: Put logs to SLS."><span class="description">Put logs to SLS.</span><pre>putLogs()</pre></a></li>
</ul>
</li>
<li class="nav-header protected">» Protected
                    <ul>
<li class="method protected "><a href="#method_getGMT" title="getGMT() :: GMT format time string."><span class="description">GMT format time string.</span><pre>getGMT()</pre></a></li>
<li class="method protected "><a href="#method_getHttpResponse" title="getHttpResponse() :: "><span class="description">getHttpResponse()
        </span><pre>getHttpResponse()</pre></a></li>
<li class="method protected "><a href="#method_loadJson" title="loadJson() :: Decodes a JSON string."><span class="description">Decodes a JSON string.</span><pre>loadJson()</pre></a></li>
</ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="method private "><a href="#method_send" title="send() :: "><span class="description">send()
        </span><pre>send()</pre></a></li>
<li class="method private "><a href="#method_sendRequest" title="sendRequest() :: "><span class="description">sendRequest()
        </span><pre>sendRequest()</pre></a></li>
<li class="method private "><a href="#method_setEndpoint" title="setEndpoint() :: "><span class="description">setEndpoint()
        </span><pre>setEndpoint()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i title="Properties" class="icon-custom icon-property"></i> Properties
                    <ul></ul>
</li>
<li class="nav-header protected">» Protected
                    <ul>
<li class="property protected "><a href="#property_accessKey" title="$accessKey() :: "><span class="description">aliyun accessKey</span><pre>$accessKey</pre></a></li>
<li class="property protected "><a href="#property_accessKeyId" title="$accessKeyId() :: "><span class="description">aliyun accessKeyId</span><pre>$accessKeyId</pre></a></li>
<li class="property protected "><a href="#property_endpoint" title="$endpoint() :: "><span class="description">SLS endpoint</span><pre>$endpoint</pre></a></li>
<li class="property protected "><a href="#property_isRowIp" title="$isRowIp() :: "><span class="description">Check if the host if row ip.</span><pre>$isRowIp</pre></a></li>
<li class="property protected "><a href="#property_port" title="$port() :: "><span class="description">Http send port. The dafault value is 80.</span><pre>$port</pre></a></li>
<li class="property protected "><a href="#property_slsHost" title="$slsHost() :: "><span class="description">sls sever host.</span><pre>$slsHost</pre></a></li>
<li class="property protected "><a href="#property_source" title="$source() :: "><span class="description">the local machine ip address.</span><pre>$source</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a xmlns:php="http://php.net/xsl" id="\Aliyun_Log_Client"></a><ul xmlns:php="http://php.net/xsl" class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Aliyun_Log_Client.html">Aliyun_Log_Client</a>
</li>
</ul>
<div xmlns:php="http://php.net/xsl" class="element class">
<p class="short_description">Aliyun_Log_Client class is the main class in the SDK. It can be used to
communicate with SLS server to put/get data.</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="">sls_dev</a></td>
</tr>
<tr>
<th>package</th>
<td><a href="../packages/SLS_PHP_SDK.html">SLS_PHP_SDK</a></td>
</tr>
</table>
<h3>
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method___construct"></a><div class="element clickable method public method___construct " data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Aliyun_Log_Client constructor</h2>
<pre>__construct(string $endpoint, string $accessKeyId, string $accessKey) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$endpoint</h4>
<code>string</code><p>SLS host name, for example, <a href="http://cn-hangzhou.sls.aliyuncs.com">http://cn-hangzhou.sls.aliyuncs.com</a></p></div>
<div class="subelement argument">
<h4>$accessKeyId</h4>
<code>string</code><p>aliyun accessKeyId</p></div>
<div class="subelement argument">
<h4>$accessKey</h4>
<code>string</code><p>aliyun accessKey</p></div>
</div></div>
</div>
<a id="method_getHistograms"></a><div class="element clickable method public method_getHistograms " data-toggle="collapse" data-target=".method_getHistograms .collapse" title="public">
<h2>Get histograms of requested query from SLS.</h2>
<pre>getHistograms(\Aliyun_Log_Models_GetHistogramsRequest $request) : \Aliyun_Log_Models_GetHistogramsResponse</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Unsuccessful opertaion will cause an Aliyun_Log_Exception.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$request</h4>
<code>\Aliyun_Log_Models_GetHistogramsRequest</code><p>the GetHistograms request parameters class.</p></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code>\Aliyun_Log_Exception</code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Aliyun_Log_Models_GetHistogramsResponse</code></div>
</div></div>
</div>
<a id="method_getLogs"></a><div class="element clickable method public method_getLogs " data-toggle="collapse" data-target=".method_getLogs .collapse" title="public">
<h2>Get logs from SLS.</h2>
<pre>getLogs(\Aliyun_Log_Models_GetLogsRequest $request) : \Aliyun_Log_Models_GetLogsResponse</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Unsuccessful opertaion will cause an Aliyun_Log_Exception.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$request</h4>
<code>\Aliyun_Log_Models_GetLogsRequest</code><p>the GetLogs request parameters class.</p></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code>\Aliyun_Log_Exception</code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Aliyun_Log_Models_GetLogsResponse</code></div>
</div></div>
</div>
<a id="method_listLogstores"></a><div class="element clickable method public method_listLogstores " data-toggle="collapse" data-target=".method_listLogstores .collapse" title="public">
<h2>List all logstores of requested project.</h2>
<pre>listLogstores(\Aliyun_Log_Models_ListLogstoresRequest $request) : \Aliyun_Log_Models_ListLogstoresResponse</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Unsuccessful opertaion will cause an Aliyun_Log_Exception.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$request</h4>
<code>\Aliyun_Log_Models_ListLogstoresRequest</code><p>the ListLogstores request parameters class.</p></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code>\Aliyun_Log_Exception</code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Aliyun_Log_Models_ListLogstoresResponse</code></div>
</div></div>
</div>
<a id="method_listTopics"></a><div class="element clickable method public method_listTopics " data-toggle="collapse" data-target=".method_listTopics .collapse" title="public">
<h2>List all topics in a logstore.</h2>
<pre>listTopics(\Aliyun_Log_Models_ListTopicsRequest $request) : \Aliyun_Log_Models_ListTopicsResponse</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Unsuccessful opertaion will cause an Aliyun_Log_Exception.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$request</h4>
<code>\Aliyun_Log_Models_ListTopicsRequest</code><p>the ListTopics request parameters class.</p></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code>\Aliyun_Log_Exception</code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Aliyun_Log_Models_ListTopicsResponse</code></div>
</div></div>
</div>
<a id="method_putLogs"></a><div class="element clickable method public method_putLogs " data-toggle="collapse" data-target=".method_putLogs .collapse" title="public">
<h2>Put logs to SLS.</h2>
<pre>putLogs(\Aliyun_Log_Models_PutLogsRequest $request) : \Aliyun_Log_Models_PutLogsResponse</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Unsuccessful opertaion will cause an Aliyun_Log_Exception.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$request</h4>
<code>\Aliyun_Log_Models_PutLogsRequest</code><p>the PutLogs request parameters class</p></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code>\Aliyun_Log_Exception</code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Aliyun_Log_Models_PutLogsResponse</code></div>
</div></div>
</div>
<a id="method_getGMT"></a><div class="element clickable method protected method_getGMT " data-toggle="collapse" data-target=".method_getGMT .collapse" title="protected">
<h2>GMT format time string.</h2>
<pre>getGMT() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_getHttpResponse"></a><div class="element clickable method protected method_getHttpResponse " data-toggle="collapse" data-target=".method_getHttpResponse .collapse" title="protected">
<h2>getHttpResponse()
        </h2>
<pre>getHttpResponse($method, $url, $body, $headers) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$method</h4></div>
<div class="subelement argument"><h4>$url</h4></div>
<div class="subelement argument"><h4>$body</h4></div>
<div class="subelement argument"><h4>$headers</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a id="method_loadJson"></a><div class="element clickable method protected method_loadJson " data-toggle="collapse" data-target=".method_loadJson .collapse" title="protected">
<h2>Decodes a JSON string.</h2>
<pre>loadJson($json, $requestId) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Unsuccessful decode will cause an Aliyun_Log_Exception.</p></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$json</h4></div>
<div class="subelement argument"><h4>$requestId</h4></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code>\Aliyun_Log_Exception</code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_send"></a><div class="element clickable method private method_send " data-toggle="collapse" data-target=".method_send .collapse" title="private">
<h2>send()
        </h2>
<pre>send($method, $project, $body, $resource, $params, $headers) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$method</h4></div>
<div class="subelement argument"><h4>$project</h4></div>
<div class="subelement argument"><h4>$body</h4></div>
<div class="subelement argument"><h4>$resource</h4></div>
<div class="subelement argument"><h4>$params</h4></div>
<div class="subelement argument"><h4>$headers</h4></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code>\Aliyun_Log_Exception</code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a id="method_sendRequest"></a><div class="element clickable method private method_sendRequest " data-toggle="collapse" data-target=".method_sendRequest .collapse" title="private">
<h2>sendRequest()
        </h2>
<pre>sendRequest($method, $url, $body, $headers) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$method</h4></div>
<div class="subelement argument"><h4>$url</h4></div>
<div class="subelement argument"><h4>$body</h4></div>
<div class="subelement argument"><h4>$headers</h4></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code>\Aliyun_Log_Exception</code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a id="method_setEndpoint"></a><div class="element clickable method private method_setEndpoint " data-toggle="collapse" data-target=".method_setEndpoint .collapse" title="private">
<h2>setEndpoint()
        </h2>
<pre>setEndpoint($endpoint) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$endpoint</h4></div>
</div></div>
</div>
<h3>
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_accessKey"> </a><div class="element clickable property protected property_accessKey" data-toggle="collapse" data-target=".property_accessKey .collapse" title="protected">
<h2>aliyun accessKey</h2>
<pre>$accessKey : string</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_accessKeyId"> </a><div class="element clickable property protected property_accessKeyId" data-toggle="collapse" data-target=".property_accessKeyId .collapse" title="protected">
<h2>aliyun accessKeyId</h2>
<pre>$accessKeyId : string</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_endpoint"> </a><div class="element clickable property protected property_endpoint" data-toggle="collapse" data-target=".property_endpoint .collapse" title="protected">
<h2>SLS endpoint</h2>
<pre>$endpoint : string</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_isRowIp"> </a><div class="element clickable property protected property_isRowIp" data-toggle="collapse" data-target=".property_isRowIp .collapse" title="protected">
<h2>Check if the host if row ip.</h2>
<pre>$isRowIp : string</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_port"> </a><div class="element clickable property protected property_port" data-toggle="collapse" data-target=".property_port .collapse" title="protected">
<h2>Http send port. The dafault value is 80.</h2>
<pre>$port : integer</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_slsHost"> </a><div class="element clickable property protected property_slsHost" data-toggle="collapse" data-target=".property_slsHost .collapse" title="protected">
<h2>sls sever host.</h2>
<pre>$slsHost : string</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_source"> </a><div class="element clickable property protected property_source" data-toggle="collapse" data-target=".property_source .collapse" title="protected">
<h2>the local machine ip address.</h2>
<pre>$source : string</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor v2.8.0-3-gd2074ac</a> and<br>
            generated on 2015-01-26T01:53:31-08:00.<br></footer></div>
</div>
</body>
</html>
